<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>Remote API reference</title>
<link rel="stylesheet" type="text/css" href="../style.css">
</head>

<body>

<div align="center">
<table class=allEncompassingTable >
 <tr>
  <td >
<p><a href="../index.html" TARGET="_top"><img src="images/homeImg.png"></a></p>



<h1>Remote API reference</h1>

<p class=warningBox>The remote API, or <em>legacy remote API</em>, should not be mixed-up with the <a href="b0RemoteApiOverview.htm">B&Oslash;-based remote API</a>, which is a newer version of the remote API that is more flexible, easier to use and most importantly, much simpler to extend.</p>

<p class=infoBox>If the function you are looking for is not listed below, then make sure to have a look at the generic function <a href="remoteApiFunctions.htm#simxCallScriptFunction">simxCallScriptFunction</a>, which allows you to implement virtually any remote API function.</p>


<pre class=lightGreyBox>
<a href="remoteApiFunctions.htm#simxAddStatusbarMessage">simxAddStatusbarMessage</a>
<a href="remoteApiFunctions.htm#simxAppendStringSignal">simxAppendStringSignal</a>
<a href="remoteApiFunctions.htm#simxAuxiliaryConsoleClose">simxAuxiliaryConsoleClose</a>
<a href="remoteApiFunctions.htm#simxAuxiliaryConsoleOpen">simxAuxiliaryConsoleOpen</a>
<a href="remoteApiFunctions.htm#simxAuxiliaryConsolePrint">simxAuxiliaryConsolePrint</a>
<a href="remoteApiFunctions.htm#simxAuxiliaryConsoleShow">simxAuxiliaryConsoleShow</a>
<a href="remoteApiFunctions.htm#simxBreakForceSensor">simxBreakForceSensor</a>
<a href="remoteApiFunctions.htm#simxCallScriptFunction">simxCallScriptFunction</a>
<a href="remoteApiFunctions.htm#simxCheckCollision">simxCheckCollision</a>
<a href="remoteApiFunctions.htm#simxCheckDistance">simxCheckDistance</a>
<a href="remoteApiFunctions.htm#simxClearFloatSignal">simxClearFloatSignal</a>
<a href="remoteApiFunctions.htm#simxClearInt32Signal">simxClearInt32Signal</a>
<a href="remoteApiFunctions.htm#simxClearStringSignal">simxClearStringSignal</a>
<a href="remoteApiFunctions.htm#simxCloseScene">simxCloseScene</a>
<a href="remoteApiFunctions.htm#simxCopyPasteObjects">simxCopyPasteObjects</a>
<a href="remoteApiFunctions.htm#simxCreateBuffer">simxCreateBuffer</a>
<a href="remoteApiFunctions.htm#simxCreateDummy">simxCreateDummy</a>
<a href="remoteApiFunctions.htm#simxDisplayDialog">simxDisplayDialog</a>
<a href="remoteApiFunctions.htm#simxEndDialog">simxEndDialog</a>
<a href="remoteApiFunctions.htm#simxEraseFile">simxEraseFile</a>
<a href="remoteApiFunctions.htm#simxFinish">simxFinish</a>
<a href="remoteApiFunctions.htm#simxGetAndClearStringSignal">simxGetAndClearStringSignal</a>
<a href="remoteApiFunctions.htm#simxGetArrayParam">simxGetArrayParam</a>
<a href="remoteApiFunctions.htm#simxGetBoolParam">simxGetBoolParam</a>
<a href="remoteApiFunctions.htm#simxGetCollectionHandle">simxGetCollectionHandle</a>
<a href="remoteApiFunctions.htm#simxGetConnectionId">simxGetConnectionId</a>
<a href="remoteApiFunctions.htm#simxGetDialogInput">simxGetDialogInput</a>
<a href="remoteApiFunctions.htm#simxGetDialogResult">simxGetDialogResult</a>
<a href="remoteApiFunctions.htm#simxGetFloatParam">simxGetFloatParam</a>
<a href="remoteApiFunctions.htm#simxGetFloatSignal">simxGetFloatSignal</a>
<a href="remoteApiFunctions.htm#simxGetInMessageInfo">simxGetInMessageInfo</a>
<a href="remoteApiFunctions.htm#simxGetInt32Param">simxGetInt32Param</a>
<a href="remoteApiFunctions.htm#simxGetInt32Signal">simxGetInt32Signal</a>
<a href="remoteApiFunctions.htm#simxGetJointForce">simxGetJointForce</a>
<a href="remoteApiFunctions.htm#simxGetJointMaxForce">simxGetJointMaxForce</a>
<a href="remoteApiFunctions.htm#simxGetJointMatrix">simxGetJointMatrix</a>
<a href="remoteApiFunctions.htm#simxGetJointPosition">simxGetJointPosition</a>
<a href="remoteApiFunctions.htm#simxGetLastCmdTime">simxGetLastCmdTime</a>
<a href="remoteApiFunctions.htm#simxGetLastErrors">simxGetLastErrors</a>
<a href="remoteApiFunctions.htm#simxGetModelProperty">simxGetModelProperty</a>
<a href="remoteApiFunctions.htm#simxGetObjectChild">simxGetObjectChild</a>
<a href="remoteApiFunctions.htm#simxGetObjectFloatParameter">simxGetObjectFloatParameter</a>
<a href="remoteApiFunctions.htm#simxGetObjectGroupData">simxGetObjectGroupData</a>
<a href="remoteApiFunctions.htm#simxGetObjectHandle">simxGetObjectHandle</a>
<a href="remoteApiFunctions.htm#simxGetObjectIntParameter">simxGetObjectIntParameter</a>
<a href="remoteApiFunctions.htm#simxGetObjectOrientation">simxGetObjectOrientation</a>
<a href="remoteApiFunctions.htm#simxGetObjectParent">simxGetObjectParent</a>
<a href="remoteApiFunctions.htm#simxGetObjectPosition">simxGetObjectPosition</a>
<a href="remoteApiFunctions.htm#simxGetObjectQuaternion">simxGetObjectQuaternion</a>
<a href="remoteApiFunctions.htm#simxGetObjects">simxGetObjects</a>
<a href="remoteApiFunctions.htm#simxGetObjectSelection">simxGetObjectSelection</a>
<a href="remoteApiFunctions.htm#simxGetObjectVelocity">simxGetObjectVelocity</a>
<a href="remoteApiFunctions.htm#simxGetOutMessageInfo">simxGetOutMessageInfo</a>
<a href="remoteApiFunctions.htm#simxGetPingTime">simxGetPingTime</a>
<a href="remoteApiFunctions.htm#simxGetStringParam">simxGetStringParam</a>
<a href="remoteApiFunctions.htm#simxGetStringSignal">simxGetStringSignal</a>
<a href="remoteApiFunctions.htm#simxGetUIButtonProperty">simxGetUIButtonProperty</a>
<a href="remoteApiFunctions.htm#simxGetUIEventButton">simxGetUIEventButton</a>
<a href="remoteApiFunctions.htm#simxGetUIHandle">simxGetUIHandle</a>
<a href="remoteApiFunctions.htm#simxGetUISlider">simxGetUISlider</a>
<a href="remoteApiFunctions.htm#simxGetVisionSensorDepthBuffer">simxGetVisionSensorDepthBuffer</a>
<a href="remoteApiFunctions.htm#simxGetVisionSensorImage">simxGetVisionSensorImage</a>
<a href="remoteApiFunctions.htm#simxLoadModel">simxLoadModel</a>
<a href="remoteApiFunctions.htm#simxLoadScene">simxLoadScene</a>
<a href="remoteApiFunctions.htm#simxLoadUI">simxLoadUI</a>
<a href="remoteApiFunctionsPython.htm#simxPackFloats">simxPackFloats</a>
<a href="remoteApiFunctionsPython.htm#simxPackInts">simxPackInts</a>
<a href="remoteApiFunctions.htm#simxPauseCommunication">simxPauseCommunication</a>
<a href="remoteApiFunctions.htm#simxPauseSimulation">simxPauseSimulation</a>
<a href="remoteApiFunctions.htm#simxReadForceSensor">simxReadForceSensor</a>
<a href="remoteApiFunctions.htm#simxReadProximitySensor">simxReadProximitySensor</a>
<a href="remoteApiFunctions.htm#simxReadStringStream">simxReadStringStream</a>
<a href="remoteApiFunctions.htm#simxReadVisionSensor">simxReadVisionSensor</a>
<a href="remoteApiFunctions.htm#simxReleaseBuffer">simxReleaseBuffer</a>
<a href="remoteApiFunctions.htm#simxRemoveModel">simxRemoveModel</a>
<a href="remoteApiFunctions.htm#simxRemoveObject">simxRemoveObject</a>
<a href="remoteApiFunctions.htm#simxRemoveUI">simxRemoveUI</a>
<a href="remoteApiFunctions.htm#simxSetArrayParam">simxSetArrayParam</a>
<a href="remoteApiFunctions.htm#simxSetBoolParam">simxSetBoolParam</a>
<a href="remoteApiFunctions.htm#simxSetFloatParam">simxSetFloatParam</a>
<a href="remoteApiFunctions.htm#simxSetFloatSignal">simxSetFloatSignal</a>
<a href="remoteApiFunctions.htm#simxSetInt32Param">simxSetInt32Param</a>
<a href="remoteApiFunctions.htm#simxSetInt32Signal">simxSetInt32Signal</a>
<a href="remoteApiFunctions.htm#simxSetJointMaxForce">simxSetJointMaxForce</a>
<a href="remoteApiFunctions.htm#simxSetJointPosition">simxSetJointPosition</a>
<a href="remoteApiFunctions.htm#simxSetJointTargetPosition">simxSetJointTargetPosition</a>
<a href="remoteApiFunctions.htm#simxSetJointTargetVelocity">simxSetJointTargetVelocity</a>
<a href="remoteApiFunctions.htm#simxSetModelProperty">simxSetModelProperty</a>
<a href="remoteApiFunctions.htm#simxSetObjectFloatParameter">simxSetObjectFloatParameter</a>
<a href="remoteApiFunctions.htm#simxSetObjectIntParameter">simxSetObjectIntParameter</a>
<a href="remoteApiFunctions.htm#simxSetObjectOrientation">simxSetObjectOrientation</a>
<a href="remoteApiFunctions.htm#simxSetObjectParent">simxSetObjectParent</a>
<a href="remoteApiFunctions.htm#simxSetObjectPosition">simxSetObjectPosition</a>
<a href="remoteApiFunctions.htm#simxSetObjectQuaternion">simxSetObjectQuaternion</a>
<a href="remoteApiFunctions.htm#simxSetObjectSelection">simxSetObjectSelection</a>
<a href="remoteApiFunctions.htm#simxSetSphericalJointMatrix">simxSetSphericalJointMatrix</a>
<a href="remoteApiFunctions.htm#simxSetStringSignal">simxSetStringSignal</a>
<a href="remoteApiFunctions.htm#simxSetUIButtonLabel">simxSetUIButtonLabel</a>
<a href="remoteApiFunctions.htm#simxSetUIButtonProperty">simxSetUIButtonProperty</a>
<a href="remoteApiFunctions.htm#simxSetUISlider">simxSetUISlider</a>
<a href="remoteApiFunctions.htm#simxSetVisionSensorImage">simxSetVisionSensorImage</a>
<a href="remoteApiFunctions.htm#simxStart">simxStart</a>
<a href="remoteApiFunctions.htm#simxStartSimulation">simxStartSimulation</a>
<a href="remoteApiFunctions.htm#simxStopSimulation">simxStopSimulation</a>
<a href="remoteApiFunctions.htm#simxSynchronous">simxSynchronous</a>
<a href="remoteApiFunctions.htm#simxSynchronousTrigger">simxSynchronousTrigger</a>
<a href="remoteApiFunctions.htm#simxTransferFile">simxTransferFile</a>
<a href="remoteApiFunctionsPython.htm#simxUnpackFloats">simxUnpackFloats</a>
<a href="remoteApiFunctionsPython.htm#simxUnpackInts">simxUnpackInts</a>
<a href="remoteApiFunctions.htm#simxWriteStringStream">simxWriteStringStream</a>
</pre>

<br>
<br>
 </tr>
</table> 
</div>  
  
  
</body>

</html>
